home *** CD-ROM | disk | FTP | other *** search
/ Amiga Tools 5 / Amiga Tools 5.iso / tools / dfÜ / amigafax / docs / userguide < prev   
Encoding:
Text File  |  1996-04-14  |  77.6 KB  |  2,165 lines

  1.  
  2. AmigaFax
  3. *********
  4.  
  5. A Facsimile Software Package for the Amiga Computer
  6. Copyright (C) 1991-1996 by C-Born Software Systems
  7.  
  8.  
  9. Introduction
  10. *************
  11.  
  12. This manual describes the AmigaFax software package for the Amiga
  13. family of computers. AmigaFax was originally written both to solve a
  14. personal need for shared facsimile and data on a single telephone line,
  15. and to become a commercial software product. When changing company
  16. circumstances dictated that bringing the product to commercial release
  17. level in a reasonable time frame would not be possible, it was decided
  18. to release the package in `Shareware' form, rather than deprive the
  19. Amiga community of the work that had already gone into it. While total
  20. returns from the registration fee charged have not even covered code
  21. maintenance and distribution costs, we still feel it has been a
  22. worthwhile project, especially due to the many contacts it has allowed
  23. us to form with the worldwide Amiga community.
  24.  
  25.  
  26. What is AmigaFax?
  27. ==================
  28.  
  29. AmigaFax is a software package that, in combination with a FaxModem,
  30. allows you to send and receive facsimile information from your Amiga
  31. computer.  Received faxes can be viewed, printed, forwarded to other
  32. fax machines, and saved as ILBM files which can then be accessed using
  33. many standard Amiga programs.  You can transmit text, ILBM graphics,
  34. and combinations of these as faxes. Using the AmigaFax command language
  35. you can add text from any Amiga font, along with logos and ILBM
  36. graphics, to create high quality multi-page fax documents.
  37.  
  38. AmigaFax can be set up to automatically send documents to multiple
  39. recipients, to send faxes at or after set times, to answer incoming fax
  40. calls automatically, and even to forward received faxes (useful as a
  41. vacation mechanism).
  42.  
  43. Faxes can be printed on plain paper, using your normal Amiga printer.
  44.  
  45. AmigaFax is highly configurable, allowing you to set up a custom
  46. environment that best suits your hardware and way of working.
  47.  
  48.  
  49. Summary of Features
  50. ====================
  51.  
  52.    * *Automatic Reception*
  53.      AmigaFax may be configured to receive faxes in the background, or
  54.      to answer an already ringing line in Fax mode. Autoanswer may also
  55.      be integrated with a UUCP or BBS environment, where incoming calls
  56.      may be Fax or data, by using a specially modified version of the
  57.      getty program that recognises Fax calls.
  58.  
  59.    * *Automatic Transmission*
  60.      Faxes may be queued for transmission after a particular time, to
  61.      take advantage of lower off-peak telecom rates, for example. You
  62.      may specify the number of times to try before giving up on
  63.      transmission, and the period at which retry attempts should be
  64.      made. All call progress is logged, and progress may be monitored
  65.      from the main program. Call logging displays when attempts were
  66.      made, the success or failure of the call, and the Called Number ID
  67.      of the remote Fax machine reached.
  68.  
  69.    * *Multiple Recipients*
  70.      Fax numbers may be entered either directly, or using defineable
  71.      aliases. Therefore instead of sending to `99123456', you could
  72.      send it to `Fred'. In the same way, an alias can refer to a list
  73.      of other aliases, or numbers, so that one fax could be sent to
  74.      `Customers', representing a list of customers.
  75.  
  76.    * *Flexible Fax Viewer*
  77.      The Fax viewer allows you to view a fax document at scales of from
  78.      1:1 to 1:8. A 1:3 scale igenerally gives a quite readable image
  79.      while still fitting the entire Fax width across a standard Amiga
  80.      screen. You can easily zoom in on areas of particular interest if
  81.      required. The viewer may be configured to take advantage of new
  82.      display modes (eg Productivity) and add-in high resolution display
  83.      cards (eg Retina).
  84.  
  85.    * *Powerful Document Builder*
  86.      This allows you to mix any Amiga font or ILBM graphic on a page,
  87.      to include text, ILBM, Fax, or AmigaFax command files anywhere on
  88.      a page or in a document, perform alignment at character or pixel
  89.      level, justify text regardless of font size, automatically add
  90.      standard information such as address, signature, logo, and current
  91.      time/date. Text conversion includes selectable fonts size and
  92.      styles, including underline, bold and italic.
  93.  
  94.    * *TeX to fax conversion*
  95.      The `dvifax' program (registered version only) allows TeX `dvi'
  96.      files to be converted directly to fax files.
  97.  
  98.    * *Fax Printer-Driver*
  99.      The fax printer driver allows the output of wordprocessing, DTP,
  100.      painting and drawing programs to be converted directly to fax
  101.      files.
  102.  
  103.    * *Highly User Configurable*
  104.      The configuration file allows you to set the system up to suit your
  105.      requirements. You can define your prefered editor for text and for
  106.      graphics, set a standard file to use as a template when creating
  107.      new Fax documents, customize your dial type (pulse/tone, special
  108.      prefix to get outside line, etc), set the Caller ID string to
  109.      identify yourself to remote Fax machines, define the modem type
  110.      you are using, and set many system default values.
  111.  
  112.    * *Multiple Serial Port Support*
  113.      Using the A2232 multi-serial port card, AmigaFax can support
  114.      multiple FaxModems simultaneously, each modem being able to
  115.      transmit and receive facsimiles and data.
  116.  
  117.    * *Uses Preferences Printer*
  118.      Because the Amiga Preferences printer is used to print out the
  119.      documents, you can tradeoff speed for resolution as you require.
  120.  
  121.    * *Workbench or CLI interface*
  122.      AmigaFax can be run either from the workbench, or from a shell or
  123.      CLI interface. In either case, an easy to use graphical
  124.      presentation makes operation straightforward.
  125.  
  126.  
  127. System Requirements
  128. ====================
  129.  
  130. AmigaFax requires AmigaDOS version 1.3 or greater. It operates with
  131. AmigaDOS 2.0, and will run on Amigas from the original A1000 through to
  132. the A3000. It is possible to run on an unexpanded A1000 with 512K RAM
  133. and 1 disk drive, but in this case memory and disk restraints will
  134. limit the number and size of faxes that may be generated or received.
  135. In general the more memory and disk available the better. For
  136. unattended Auto-receive operation a hard disk system is highly
  137. desirable.
  138. Certain features, such as font scaling, ASL file requester, and
  139. demand-loading of the printer symbiont rely on AmigaDOS 2.0 features,
  140. and will not operate under 1.3
  141. As of AmigaFax version 1.40, support for AmigaDOS 1.3 will not be
  142. guaranteed, however we will endeavour to maintain basic operation as
  143. long as possible, and will listen to any user feedback in this area.
  144.  
  145. AmigaFax was designed to work with the Class-2 fax interface standard,
  146. it will `not' work with Class-1 FaxModems. Versions 1.42 and above of
  147. AmigaFax can also be configured to operate with the Class-2.0 FaxModem
  148. standard.
  149.  
  150.  
  151. Installation
  152. *************
  153.  
  154. *Warning:* Be sure to back up your original disks, and use working
  155. copies of the disks for normal operation.
  156.  
  157.  
  158. Installing the Software
  159. ========================
  160.  
  161. Information on installing the AmigaFax software on your system is given
  162. in the  ReadMe  file on the distribution disk. Insert the distribution
  163. disk, and from the WorkBench double-click on the ReadMe icon for
  164. instructions.
  165.  
  166. The installation script should automatically handle most installations.
  167. To use it, from the WorkBench double-click the Install_Now icon, or
  168. from a Shell window type  amigafax:install . The script will prompt you
  169. for information required to complete the installation.
  170.  
  171. If you are updating to a later revision, the installation procedure
  172. will not overwrite your configuration or alias files, so you will not
  173. lose information. However in this case you may want to examine the
  174. files in the directories  `lib.user'  and  `s.user' on the distribution
  175. disk for examples of more recent configuration options.
  176.  
  177. The AmigaFaX software requires certain logical assignments to be made.
  178. The installation procedure will create a file `afax:s/User-Startup'. 
  179. You must edit your `S:User-Startup' (2.0) or `S:Startup-Sequence' (1.3)
  180.  to include the contents of that file, which will be typically
  181. something like:
  182.  
  183.      assign afax: Work:AmigaFax
  184.      mount null:
  185.      run >nil: <nil: l:fifo-handler
  186.      if exists afax:s/AFAX-Startup
  187.              execute afax:s/AFAX-Startup
  188.      endif
  189.  
  190. If your `devs:MountList' doesn't contain an entry for the NULL: device,
  191. append the `MountList' file from the `devs' directory on the AmigaFax
  192. to it.
  193.  
  194.  
  195. Basic Configuration
  196. ====================
  197.  
  198. There are many possible ways to operate the AmigaFax software. You may
  199. wish to operate it as the only software using your FaxModem, or have it
  200. share the modem with other software such as AmigaUUCP. The AmigaFax
  201. spooler may be started when you boot up your computer, or only when you
  202. want to send a fax. Fax Auto-Answer may be left on all the time,
  203. started only when you are expecting a fax, or not used at all.
  204.  
  205. If you want the fax-spooler to start when you boot up your system, you
  206. must add the line
  207.  
  208.      run >nil: <nil: AFAX:C/afaxspl
  209.  
  210. to your startup sequence. This can be done in the `AFAX:s/AFaxAssign' 
  211. file, for example. Normally this would only be necessary if you send a
  212. lot of faxes with delayed spooling, and your computer may be rebooted
  213. often, as the spooler is automatically started when sending a fax.
  214.  
  215. If you want auto-answer with Fax detection running constantly in
  216. background, you may either use the modified `Getty' command, or use
  217. `faa' directly, by adding the line
  218.  
  219.      run >nil: <nil: faa
  220.  
  221. somewhere in your startup sequence.
  222.  
  223. Note that the modified `getty' will allow you to receive data and fax
  224. calls effectively, and is the recommended approach. However if you only
  225. wish to receive faxes, `faa' is effective and may be started by
  226. double-clicking on the *FaxAutoAnswer* icon.
  227.  
  228.  
  229. Hardware
  230. =========
  231.  
  232. The cable between your Amiga and Modem MUST connect CTS,RTS,DTR, DCD,
  233. TXD, RXD and GND conductors. CTS and RTS are used for flow control
  234. handshaking. DTR is used to keep the modem on line - hangup occurs if
  235. it is dropped. DCD is used for carrier detection.
  236.  
  237.      TXD   2  Transmit Data
  238.      RXD   3  Receive Data
  239.      RTS   4  Request to Send
  240.      CTS   5  Clear to Send
  241.      GND   7  Signal Ground
  242.      DCD   8  Data Carrier Detect
  243.      DTR  20  Data Terminal Ready
  244.  
  245.  
  246. ARP
  247. ====
  248.  
  249. If you have the ARP library installed (`Libs:arp.library') the system
  250. will make use of it for file requesters.
  251.  
  252. Support for the ASL library under AmigaDOS2.0 has now been added to
  253. AmigaFax.  It is used in preference to ARP.
  254.  
  255.  
  256. Extra FONTS
  257. ============
  258.  
  259. Some extra fonts have been included in the FaxFonts directory. You may
  260. let the installation script copy them into your `FONTS:' directory, or
  261. under AmigaDOS2.0 you may copy them into another directory, and modify
  262. your startup to extend the `FONT:' assign to that directory. The extra
  263. fonts are from the *Computer Modern* series, as used with TeX.
  264. These fonts will normally *not* be required under AmigaDOS2.0. You are
  265. much better off using the built-in font scaling where it is available.
  266.  
  267.  
  268. Printer Setup
  269. ==============
  270.  
  271. AmigaFax currently uses the standard printer driver, as configured in
  272. `Preferences'.  Using a dot-matrix printer, Halftone Dithering, Integer
  273. Scaling, Black and White, Density 7 appears to work reasonably well.
  274.  
  275.  
  276. Configuring for Hardware and User Preferences
  277. ==============================================
  278.  
  279. You will need to modify the file  `FAXLIB:Config'  to suit your
  280. specific hardware and preferences. See Configuring the System, for
  281. details on how to do this.
  282.  
  283.  
  284. Configuring the System
  285. ***********************
  286.  
  287. The file `FAXLIB:Config'  is used to configure the basic operation of
  288. AmigaFax to suit your particular hardware and preferences. You must
  289. edit this file carefully, using a text editor. You should always keep a
  290. backup copy of this file. The configuration options are continually
  291. being added to as AmigaFax grows, so if you are upgrading you should
  292. look at the latest copy. This will *NOT* overwrite your existing
  293. configuration as part of the installation process.
  294.  
  295. From version 1.30, AmigaFax configuration can be done using local or
  296. global environmental variables. This will override the values read in
  297. from the  `FAXLIB:Config'  file. For example typing from the CLI/Shell
  298.  
  299.      SetEnv LocalID +61-52-504140
  300.  
  301. will override the `LocalID' string with the new number. Parameters set
  302. by command-line switches will override both environmental and
  303. config-file values.
  304.  
  305.  
  306. General Configuration
  307. ======================
  308.  
  309.    * *Debug*
  310.      Debug level, 0-9. Takes one numeric argument. Useful for
  311.      fault-finding, observing handshake between the Amiga and your
  312.      FaxModem.
  313.  
  314.      For version 1.42 I've made some changes, including level-3 debug
  315.      now printing configuration information, so you can now see whether
  316.      you are in XonXoff, SyncEOL, etc. modes. To make sure you see all
  317.      the config. information, you should use the -d3 command line
  318.      switch, which will be checked early in startup (before config-file
  319.      read in).
  320.  
  321.    * *LogFile*
  322.      Specifies the file for logging debug and error information. If not
  323.      given, information will not be logged.
  324.  
  325.    * *LocalID*
  326.      The rest of the line is used as the local identifier string, which
  327.      is passed to the remote fax machine. This is usually your fax
  328.      number, and is limited to 20 characters. Some faxmodems (eg Supra)
  329.      require the ID string to be enclosed in double-quotes, others do
  330.      not allow this. *Important:* This seems to be the setting which
  331.      gives new users the most problems when trying to get AmigaFax
  332.      working. If you have difficulties please try setting your
  333.      `LocalID' both with and without the enclosing double-quotes.
  334.           LocalID "123-4567"
  335.           LocalID  123-4567
  336.  
  337.    * *Device*
  338.      The device to use for connecting to the modem, usually
  339.      serial.device  (default). This should only be changed if using a
  340.      different serial device, as with a third-party serial hardware.
  341.  
  342.    * *Unit*
  343.      Takes one numeric parameter as the unit number to use on the given
  344.      device. Default is 0. For example when using the first port on the
  345.      A2232 multi-serial, set this to 2.
  346.  
  347.    * *FCLASS*
  348.      Currently must be set to 2.0 for Class-2.0 FaxModems, otherwise
  349.      will use Class-2 interface standard.
  350.  
  351.  
  352. AmigaFax User Interface
  353. ========================
  354.  
  355. These items are used by the  `afax'  program.
  356.    * *Editor*
  357.      The name of the your prefered text editor, for example `TxEd, ced,
  358.      memacs, dme, mg', or `Ed' (default). I use `mg' (MicroGnuEmacs).
  359.  
  360.    * *ILBMEditor*
  361.      The editor you prefer for editing IFF ILBM graphics, for example
  362.      `dpaint'.
  363.  
  364.    * *Template*
  365.      The name of a file to use as a template for building fax
  366.      documents, If given, the editor will be given a copy of this file
  367.      to work on when you ask for a new fax file. This may include
  368.      references to your address, your signature, etc.
  369.  
  370.  
  371. Fax Page Layout Options
  372. ========================
  373.  
  374. These items are used by the  `mkafax'  program.
  375.    * *DefaultFont*
  376.      This is the default font, used for normal text unless otherwise
  377.      specified. It takes two parameters, the font name, and size. The
  378.      TeXfont  `cmtt10 41'  looks quite good for standard text, as does
  379.      the Amiga font `courier 32'.
  380.  
  381.    * *HeaderFont*
  382.      This is the font used for page headers. My current setting is
  383.      `courier 16'.
  384.  
  385.    * *PHeader*
  386.      If given, a header will be printed on each fax page, and the rest
  387.      of the line used as the main text, along with the date, local ID
  388.      string, and page number. If not given, no header will be printed.
  389.  
  390.    * *LeftIndent*
  391.      The left indentation (border) to be used, in pixels. Many fax
  392.      machines will not print to the full fax width, and typically an
  393.      indentation of at least 50 pixels (approx 1/4 inch) on each size
  394.      is required to avoid losing characters.
  395.  
  396.    * *RightIndent*
  397.      The right indentation (border) to be used, in pixels.
  398.  
  399.    * *SyncEOL*
  400.      When set, `mkafax' will create faxes with EOL (End-Of-Line)
  401.      markers byte-aligned. While this should not be necessary, and
  402.      results in larger files, some fax modems to not correctly identify
  403.      EOL sequences which are not byte aligned, and this can cause
  404.      problems. ZyXEL modems with ROM versions before 6.00 had this
  405.      problem, and certain rare fax files could cause the modem to lock
  406.      up completely.
  407.  
  408.    * *DateFormat*
  409.      Allows user definable date format to be used in the page header.
  410.      Uses `locale.library' if available. Possible formats are:
  411.              "INTERNAL"  ........ internal date format like in AFax until V1.35
  412.              "D"         ........ internal date format for Germany (new)
  413.              "F"         ........ internal date format for France (new)
  414.              "E"         ........ internal date format for "English" (new)
  415.              "SHORT"     ........ short format from locale.library
  416.              "LONG"      ........ long format from locale.library
  417.              "%d.%m.%y"  ........ a valid format string for AmigaOS>=2.1 -
  418.                                   FormatDate()-routine in locale.library
  419.  
  420.  
  421. Fax Viewer Configuration
  422. =========================
  423.  
  424. These items are used by the  `viewafax'  program.
  425.    * *ViewScale*
  426.      Takes one numeric argument, 1-8. This is the default scale used by
  427.      the fax viewer when it starts up. A value of three allows a
  428.      standard fax to fit across the screen. A scale of 1 shows maximum
  429.      detail.
  430.  
  431.    * *CustomScreen*
  432.      Under AmigaDOS2.0 only, the value of this parameter is passed to
  433.      the OpenScreen() call in the ti_Data field of the SA_DisplayID tag
  434.      item. This allows users to define what type of screen the viewer
  435.      will appear on. The default values passed are PAL_MONITOR_ID and
  436.      HIRESLACE_KEY. The value should be entered as a hex number,
  437.      without the leading 0x, eg
  438.  
  439.      CustomScreen 00031000
  440.  
  441.      Some possible values are:
  442.           DEFAULT_MONITOR_ID        0x00000000
  443.           NTSC_MONITOR_ID           0x00011000
  444.           PAL_MONITOR_ID            0x00021000
  445.           VGA_MONITOR_ID            0x00031000
  446.           
  447.             or'ed with
  448.           
  449.           LORES_KEY                 0x00000000
  450.           HIRES_KEY                 0x00008000
  451.           SUPER_KEY                 0x00008020
  452.           HAM_KEY                   0x00000800
  453.           LORESLACE_KEY             0x00000004
  454.           HIRESLACE_KEY             0x00008004
  455.           SUPERLACE_KEY             0x00008024
  456.           HAMLACE_KEY               0x00000804
  457.           LORESDPF_KEY              0x00000400
  458.           HIRESDPF_KEY              0x00008400
  459.           SUPERDPF_KEY              0x00008420
  460.           LORESLACEDPF_KEY          0x00000404
  461.           HIRESLACEDPF_KEY          0x00008404
  462.           SUPERLACEDPF_KEY          0x00008424
  463.           LORESDPF2_KEY             0x00000440
  464.           HIRESDPF2_KEY             0x00008440
  465.           SUPERDPF2_KEY             0x00008460
  466.           LORESLACEDPF2_KEY         0x00000444
  467.           HIRESLACEDPF2_KEY         0x00008444
  468.           SUPERLACEDPF2_KEY         0x00008464
  469.           EXTRAHALFBRITE_KEY        0x00000080
  470.           EXTRAHALFBRITELACE_KEY    0x00000084
  471.           VGAEXTRALORES_KEY         0x00031004
  472.           VGALORES_KEY              0x00039004
  473.           VGAPRODUCT_KEY            0x00039024
  474.           VGAHAM_KEY                0x00031804
  475.           VGAEXTRALORESLACE_KEY     0x00031005
  476.           VGALORESLACE_KEY          0x00039005
  477.           VGAPRODUCTLACE_KEY        0x00039025
  478.           VGAHAMLACE_KEY            0x00031805
  479.           VGAEXTRALORESDPF_KEY      0x00031404
  480.           VGALORESDPF_KEY           0x00039404
  481.           VGAPRODUCTDPF_KEY         0x00039424
  482.           VGAEXTRALORESLACEDPF_KEY  0x00031405
  483.           VGALORESLACEDPF_KEY       0x00039405
  484.           VGAPRODUCTLACEDPF_KEY     0x00039425
  485.           VGAEXTRALORESDPF2_KEY     0x00031444
  486.           VGALORESDPF2_KEY          0x00039444
  487.           VGAPRODUCTDPF2_KEY        0x00039464
  488.           VGAEXTRALORESLACEDPF2_KEY 0x00031445
  489.           VGALORESLACEDPF2_KEY      0x00039445
  490.           VGAPRODUCTLACEDPF2_KEY    0x00039465
  491.           VGAEXTRAHALFBRITE_KEY     0x00031084
  492.           VGAEXTRAHALFBRITELACE_KEY 0x00031085
  493.  
  494.  
  495. Fax Printer Configuration
  496. ==========================
  497.  
  498. These items are used by the `afaxprt' program.
  499.    * *MinLines*
  500.      `MinLines' is used to scale a fax page to fit on a printer page.
  501.      If the fax page is longer then the printer page by less than
  502.      MinLines, it will be scaled to fit. A value of around 500 works
  503.      for most faxes.
  504.  
  505. `MinLines' had a different meaning in versions of AmigaFax prior to
  506. 1.32, as follows:
  507.      Takes one numeric argument. This is the minimum number of lines
  508.      that must be on a fax page before we print it. The default value
  509.      is 0 (zero), meaning print all pages. This is for cut-sheet
  510.      feeders (Laser Printers), where the fax may be just a little
  511.      longer than one page. Use a value of around 100 here to stop
  512.      getting `blank pages' printed out.
  513.  
  514.  
  515. Fax Spooler Configuration
  516. ==========================
  517.  
  518. These items are used by the `afaxspl'  program.
  519.    * *SpoolInterval*
  520.      This is the time interval, in minutes, at which the outbound fax
  521.      queue is scanned for untransmitted files.
  522.  
  523.  
  524. Fax Receiver Configuration
  525. ===========================
  526.  
  527. These items are used by the  `faa'  program.
  528.    * *RSetup*
  529.      The receive setup string. This optional string is sent to the
  530.      modem. Unlike versions before 1.23, the string is *not*
  531.      automatically prefixed with AT .  Instead, the line is sent as it
  532.      appears, allowing multiple commands to be sent when initializing
  533.      the modem. This allows you to add commands to set such things as
  534.      speaker use and volume. Remember, if an AT is required, you *must*
  535.      add it yourself.
  536.  
  537.    * *RStatus*
  538.      Receive Status. If present, a status window will pop up when a fax
  539.      is being received, showing various details such as name, connect
  540.      speed, transmitter ID, amount of data received. It takes two
  541.      optional numeric parameters, which are used for the top and left
  542.      edge pixel positions to place the window, and a further two, width
  543.      and height, which if given cause the system default font to be
  544.      used.
  545.  
  546.    * *DLEmode*
  547.      There are many incompatible modems and modem ROM revisions about.
  548.      This allows you to specify certain things about how your FaxModem
  549.      sends your data. It currently takes one numeric argument, (0, 1 or
  550.      3).     
  551.               
  552.  
  553.         * 0  (default) treat DLE in received data as escape          
  554.           (Maestro 3.1, ZyXEL 3.99+)     
  555.  
  556.         * 1  Received DLE is g3 data  (ZyXEL Vn3.90, Supra?)     
  557.  
  558.         * 3  RAW input mode. Data is saved raw. For debug only.     
  559.  
  560.    * *RRate*
  561.      Sets the initial baud rate (`Receive Rate') for modem
  562.      communications. This defaults to 2400, for simple faxmodems that
  563.      normally communicate at 2400, but switch to 19200 for actual fax
  564.      data. More advanced modems, such as the ZyXEL, will communicate at
  565.      19200 baud or greater, at a locked DCE-DTE rate, as per the
  566.      FaxModem specification. I have this set to 19200, which is the
  567.      highest speed common to my FaxModem and the AS2232 multiport
  568.      serial card.
  569.  
  570.      When receipt handshaking is via the `getty' program, `RRate' is
  571.      not used.
  572.  
  573.  
  574. Fax Transmitter Configuration
  575. ==============================
  576.  
  577. These items are used by the `afaxsend'  program.
  578.  
  579.    * *WSetup*
  580.      The transmit setup string. This optional string is sent to the
  581.      modem. As in the `RSetup' line, the line is sent to the modem as it
  582.      appears (since 1.23). This allows you to add commands to set such
  583.      things as speaker use and volume.
  584.  
  585.    * *DialType*
  586.      Takes the parameters `Pulse' (default) or `Tone'.
  587.  
  588.    * *DialPrefix*
  589.      Prefix to add before number when dialling. I use it to get an
  590.      outside line (dials 0 first), by setting it to `ATDP0,DT,' which
  591.      will pulse-dial 0, then tone-dial the rest of the number.
  592.  
  593.    * *DoPadding*
  594.      This should not be necessary. However, some FaxModems to not
  595.      observe the minimum scan-time restrictions set by the standard.
  596.      When connecting to slower fax machines, this may result in missed
  597.      scan-lines. Note that if you set this parameter, it will usually
  598.      result in fax transmissions taking longer, as worst-case padding
  599.      must be added.
  600.  
  601.    * *WStatus*
  602.      Write Status. If present, a status window will pop up when a fax is
  603.      being transmitted, showing various details such as name, connect
  604.      speed, receiver ID, percent of file sent. It takes two optional
  605.      numeric parameters, which are used for the top and left edge pixel
  606.      positions to place the window, and a further two, width and height,
  607.      which if given cause the system default font to be used.
  608.  
  609.    * *ScriptBeforeSending*
  610.      This may contain the name of a CLI command script to be executed
  611.      before a fax is sent. The script is executed synchronously before
  612.      the serial device is locked or opened.
  613.  
  614.    * *ScriptAfterSending*
  615.      This may contain the name of a CLI command script to be executed
  616.      after a fax has been sent. The script is executed synchronously
  617.      just before `afaxsend' terminates.
  618.  
  619.    * *XonXoff*
  620.      If set, causes `afaxsend' to use XON/XOFF handshaking with the
  621.      faxmodem while transmitting fax data. This is not normally
  622.      necessary, as the modems should implement CTS/RTS hardware
  623.      handshaking, but some modems, such as the NetComm M7F, have a
  624.      hardware bug that prevents the hardware handshake working.
  625.      Symptoms are buffer overrun, and loss of fax data.
  626.  
  627.      For version 1.42 and above, use of the XonXoff config variable has
  628.      been changed as follows:
  629.  
  630.           XonOff 0  - disabled
  631.                  1  - Use maximum buffer (1000 bytes)
  632.                 nnn - Use nnn size line buffer
  633.  
  634.      This allows you to set the size of the line AmigaFax uses for
  635.      asynchronous writes, which controls the granularity of XONXOFF
  636.      checking.
  637.  
  638.      For testing, I'd start off with something like
  639.  
  640.           XonOff 10
  641.  
  642.      which means that AmigaFax will check for XOFF every 10 characters
  643.      sent. As the value is increased, overall throughput should
  644.      increase, until the point where the modem buffer overflows with a
  645.      single line.
  646.  
  647.      If that doesn't help, perhaps the USR hasn't used the default
  648.      XonXoff control like it should. You can force this by putting an
  649.      AT+FLO=1 in your setting string. Alternatively, AT+FLO=2 will
  650.      force hardware handshake, if the modem supports it.
  651.  
  652.  
  653. PrintSymb Configuration
  654. ========================
  655.  
  656. These items are used by the `PrintSymb' program.
  657.  
  658.    * *FAXFILE*
  659.      This contains the name of the file to write fax-data from the
  660.      printer-driver to. If not defined, data will be written to the file
  661.      `FAXSPOOL:P_xxxx.AFX', where `xxxx' is used to create a new
  662.      sequential name, or if that cannot be done it will be written to
  663.      `Ram:fax.prt'.
  664.  
  665.      When you do not with the fax file to be retained, you may direct
  666.      is to a temporary file, eg `SetEnv FAXFILE t:fx'. The variable
  667.      will be read in again every time file is created, so you may
  668.      change it dynamically.
  669.  
  670.    * *ClipPage*
  671.      This is used to clip whitespace from the top and bottom of a page
  672.      sent to the fax printer driver. At present only bottom-clipping is
  673.      implemented, but for future compatability use the following values:
  674.           ClipPage 1    # Remove whitespace at bottom of page
  675.           ClipPage 2    # Remove whitespace at top of page
  676.           ClipPage 3    # Remove whitespace at top and bottom of page
  677.  
  678.    * *FaxPrintNotify*
  679.      This may be optionally used to specify another command to run when
  680.      the afax printer-driver has captured a fax-file, rather than the
  681.      standard `afax:c/afax'. It may be a standard command, or a
  682.      shell-script. The command will be run with one parameter, the name
  683.      of the Fax-File. For example:
  684.  
  685.           FaxPrintNotify AFAX:S/afax.scp
  686.  
  687.      The shell script AFAX:S/afax.scp will be run, with the name of the
  688.      fax-file as its only parameter.
  689.  
  690.  
  691. Class-2.0 Operation
  692. ====================
  693.  
  694. The protocol used by AmigaFax for communication between the Amiga and
  695. the FaxModem is known as `Class-2'. This standard has been around in
  696. draft form for several years, and the majority of FaxModems on the
  697. market use a version of it. However the standard went through many
  698. draft revisions without passing industry ballot and being approved, and
  699. modem manufacturers came up with different interpretations of the draft
  700. versions. When the standard was finally approved in April 1993, it was
  701. known as Class-2.0 to differentiate it from the many Class-2
  702. implementations. The released standard is `ANSI/TIA/EIA-592-1993', or
  703. `Asynchronous Facsimile DCE Control Standard - Service Class II'.
  704.  
  705. Versions 1.42 and above of AmigaFax can be configured to use the
  706. approved standard interface. We have tested the software satisfactorily
  707. with some manufacturers implementations of the standard, we have found
  708. other implementations of Class-2.0 that do not fully comply. There are
  709. some sample configuration files included with the distribution that
  710. have been provided by AmigaFax testers, which have been found to work
  711. with specific FaxModems. Users are encouraged to submit configurations
  712. they find to work with other hardware.
  713.  
  714. To determine whether your modem uses Class-2 or Class-2.0 interface
  715. standards, use a terminal emulator program to connect to the FaxModem,
  716. and enter the command:
  717.  
  718.      AT+FCLASS=?
  719.  
  720. The modem should respond with a string containing a 2, a 2.0, or
  721. possibly both. The ZyXEL U-1496 responds with both as it can be
  722. configured to use either standard. If your modem does not respond with
  723. a 2 or 2.0, it will `NOT' work with AmigaFax.
  724.  
  725. To configure `faa' and `afaxsend' to operate in Class-2.0 mode, you
  726. must have the line:
  727.  
  728.      FCLASS 2.0
  729.  
  730. in your FAXLIB:Config file, or set it in your global or local
  731. environment:
  732.  
  733.      SetEnv FCLASS 2.0
  734.  
  735. The new getty uses bit 3 of the -F flags to indicate Class-2.0
  736. operation, so you must add 8 to these flags on getty startup.
  737.  
  738.      getty -Mh -B19200 -x9 -F6 AT&C1&D3+FCC=1,5,0,2
  739.      
  740.       becomes
  741.      
  742.      getty -Mh -B19200 -x9 -F14 AT&C1&D3+FCC=1,5,0,2
  743.  
  744. If you are upgrading from a previous version of AmigaFax to version
  745. 1.42 and you have any configuration values setup in config file or
  746. environment for WSetup, RSetup, XONXOFF, or various modem command
  747. overrides, you should remove them, or modify them according to
  748. specifications below.
  749.  
  750.    * AFaxSend
  751.  
  752.      For Class-2.0 the default WSetup string is:
  753.  
  754.           AT&C1&D3S7=255+FCLASS=2.0+FNR=1,1,1,0+FCC=1,5,0,2
  755.  
  756.    * Faa
  757.  
  758.      For Class-2.0 the default RSetup string is:
  759.  
  760.           AT&C1&D3S7=255+FCLASS=2.0+FNR=1,1,1,0+FCR=1+FAA=1+FCC=1,5,0,2 ATS0=2
  761.  
  762.      With the change to 2.0, the Phase-C bit order on receive appears to
  763.      have been reversed. I am not sure if this is universal, or a fault
  764.      with the ZyXEL 6.13 ROMs, as the ZyXEL currently disregards the
  765.      +FBO bit-order control. I am currently reversing when in 2.0,
  766.      UNLESS the config variable "OldBitOrder" is defined. If you
  767.      receive faxes that appear unreadable in Class-2.0 mode, try a
  768.  
  769.           SetEnv OldBitOrder 1
  770.  
  771.      and see if that helps. If so, PLEASE let me know as soon as
  772.      possible.
  773.  
  774.    * Modem Commands
  775.  
  776.      The inbuilt modem commands are shown below. You should not need to
  777.      override these, as 2.0 is now an approved standard. Some of these
  778.      (eg +FPTS) are not used by AmigaFax.
  779.  
  780.           +FCO +FCI +FTI +FCS +FIS +FKS +FPTS +FET +FHS
  781.           +FDT +FDR +FLI +FIS
  782.  
  783.      Note that some of the Class-2 inbuilts have been modified also. 
  784.      The current Class-2 commands are:
  785.  
  786.           +FCON +FCSI +FTSI +FDCS +FDIS +FK +FPTS +FET +FHNG
  787.           +FDT  +FDR  +FLID +FDIS
  788.  
  789.    * Flow Control
  790.  
  791.      Class-2.0 defaults to Xon/Xoff flow control, which I am not too
  792.      fond of. This will be set automatically (afaxsend only) when in
  793.      2.0 mode. However you can override this with the XONXOFF config
  794.      variable.
  795.  
  796.           SetEnv XonXoff 1
  797.  
  798.      will force Xon/Xoff flow control to be used,
  799.  
  800.           SetEnv XonXoff 0
  801.  
  802.      will disable it, regardless of the FCLASS setting.
  803.  
  804.      However if you have hardware handshaking, and want your modem to
  805.      use it, you should add
  806.  
  807.           AT+FLO=2
  808.  
  809.      to your RSetup and WSetup strings, as well as to your getty startup
  810.      initialization array. This may become the default later. Comments ?
  811.  
  812.    * getty
  813.  
  814.      Under the original Class-2 specification, it was possible to leave
  815.      the modem in FCLASS=0 (data) mode, with FAA=1, and to automatically
  816.      receive a fax, along with data on connect speed and remote ID.
  817.  
  818.      With the ZyXEL U-1946, supporting Class-2 and Class-2.0, in data
  819.      mode the modem reports fax connection parameters in Class-2 format
  820.      only. With other Class-2.0 modems, it may not do so at all.
  821.      Instead the standard allows for a modem in FCLASS=2.0 with FAA=1 to
  822.      automatically detect a data call, and to connect in data mode. The
  823.      parameter +FNR=1,1,1,0 must be set in order to get connection data,
  824.      and to negotiate transfer rates greater than 2400 baud!
  825.  
  826.      To cope with this, the getty -F flag has been extended so that bit
  827.      3 set (=8) means connect as FCLASS=2.0. The modem will be set to
  828.      FCLASS=2.0, FAA=1, FNR=1,1,1,0. Whenever another program requests
  829.      use of the serial port from getty, getty will set the modem back to
  830.      FCLASS=0, or data mode. This is also done when getty exits.
  831.  
  832.      While adding this code, I also traced and fixed a (long-standing
  833.      ?) bug in getty, which was causing my machine to crash when getty
  834.      shut down. It was caused by the order of closing in the myexit()
  835.      function. This effects other versions of getty, including the one
  836.      distributed with AmigaUUCP 1.17beta.
  837.  
  838.    * Other Changes for 1.42
  839.  
  840.      I've made some changes, including level-3 debug now printing
  841.      configuration information, so you can now see whether you are in
  842.      XonXoff, SyncEOL, etc. modes. To make sure you see all the config.
  843.      information, you should use the -d3 command line switch, which
  844.      will be checked early in startup (before config-file read in).
  845.  
  846.      I've also changed the use of the XonXoff config variable, as
  847.      follows:
  848.  
  849.           XonOff 0  - disabled
  850.                  1  - Use maximum buffer (1000 bytes)
  851.                 nnn - Use nnn size line buffer
  852.  
  853.      This allows you to set the size of the line AmigaFax uses for
  854.      asynchronous writes, which controls the granularity of XONXOFF
  855.      checking.
  856.  
  857.      For testing, I'd start off with something like
  858.  
  859.           XonOff 10
  860.  
  861.      which means that AmigaFax will check for XOFF every 10 characters
  862.      sent. As the value is increased, overall throughput should
  863.      increase, until the point where the modem buffer overflows with a
  864.      single line.
  865.  
  866.      If that doesn't help, perhaps the USR hasn't used the default
  867.      XonXoff control like it should. You can force this by putting an
  868.      AT+FLO=1 in your setting string. Alternatively, AT+FLO=2 will
  869.      force hardware handshake, if the modem supports it.
  870.  
  871.  
  872. Modem Command and Status Strings
  873. =================================
  874.  
  875. Certain  modem commands and status codes have now been made variable.
  876. The variables default to their own value, and may be set in the Config
  877. file, or as environment variables.
  878.  
  879.      eg    setenv +FLID +FLI
  880.  
  881. will result in the string `+FLI' rather than `+FLID' being used for
  882. setting the local ID code.
  883.  
  884. Variables are:
  885.  
  886.    * Status     
  887.               
  888.  
  889.         * +FCON      Fax connect established     
  890.  
  891.         * +FCSI     Called station identifier follows     
  892.  
  893.         * +FTSI     Transmitting station identifier follows     
  894.  
  895.         * +FDCS     Current session parameters follow     
  896.  
  897.         * +FK     
  898.  
  899.         * +FPTS     
  900.  
  901.         * +FHNG     Fax hangup (terminal)     
  902.  
  903.    * Command     
  904.               
  905.  
  906.         * +FDT     Fax Data Transmit (I am about to transmit)     
  907.  
  908.         * +FDR     Fax Data Receive     
  909.  
  910.         * +FLID     Local ID string follows     
  911.  
  912.    * Dual Use     
  913.               
  914.  
  915.         * +FET     Fax End of Transmission (Followed by status code)     
  916.  
  917.         * +FDIS     Constrain session parameters     
  918.  
  919.  
  920. Configuration Variables Index
  921. ==============================
  922.  
  923.  
  924. The Workbench Interface
  925. ************************
  926.  
  927. Once configured, AmigaFax may be operated either from a Shell or CLI
  928. (Command Line Interface), or from the Workbench. If you choose to
  929. operate from the Workbench, you will find three main icons, `AmigaFax',
  930. `FaxAutoAnswer' and `FaxSpool'.
  931.  
  932.  
  933. AmigaFax
  934. =========
  935.  
  936. When you double-click on the `AmigaFax' icon, the main AmigaFax control
  937. window will open. This allows you to edit, compile and view faxes,
  938. queue them for transmission, review previously queued transmissions,
  939. and so forth. There are currently six string gadgets, six pushbutton
  940. gadgets, and one toggle gadget on the control window.
  941.  
  942. The gadget functions are:
  943.  
  944.    * *FINE/STD*
  945.      This toggle gadget allows the user to toggle between `Fine' (200
  946.      DPI) and `Standard' (100 DPI) vertical resolution, when creating
  947.      AFax files.  Standard resolution takes half the space, and half the
  948.      time to transmit, of `Fine' mode, but `Fine' looks *much* nicer !!
  949.  
  950.    * *To:*
  951.      This is the intended recipient of the Fax. It may be just a phone
  952.      number, or it may be an alias. When you enter a string and press
  953.      return, if the first character is a digit it will be treated as a
  954.      number, otherwise it will be checked for aliases. If no aliases are
  955.      found, the string is removed, otherwise the number of aliases
  956.      found is shown. See Aliases, for more information on aliases.
  957.  
  958.    * *From:*
  959.      This is picked up from the `LocalID' field in your Config file, if
  960.      present. You may override this value. It is a 20 character string
  961.      sent to the remote Fax to identify you as the sender, usually your
  962.      phone number for return faxes.
  963.  
  964.    * *Source:*
  965.      This is the name of the fax source document, usually an AmigaFax
  966.      command (`.FCOM') file, although plain text or ILBM files may also
  967.      be used.  If you press return with an empty string, and ARP is
  968.      installed, a requester will prompt you for a filename.
  969.  
  970.    * *AFAX:*
  971.      This is the name for the actual fax file. The system will usually
  972.      pick a name for you, but you may wish to override it.  Note that
  973.      the AFAX file name will be reserved, but not actually created,
  974.      until time to send the Fax. You may force creation with the "Make"
  975.      gadget if you wish to test that it is created correctly.  If a
  976.      document is to be faxed to multiple recipients, only one copy of
  977.      the AFAX file will be made. It is automatically deleted when all
  978.      recipients have been reached.
  979.  
  980.    * *Tries:*
  981.      The maximum number of times to try to get a fax through to a
  982.      specific recipient if problems are encountered, such as remote
  983.      phone being engaged. Defaults to three.
  984.  
  985.    * *Time:*
  986.      The Fax will not be sent until after this time. An empty field
  987.      means send at any time. Fill in as hh:mm, (24 hour format) then
  988.      press return. The system will interpret the time, and display the
  989.      result. Time can only be in the future, past time is rounded up by
  990.      a day.
  991.  
  992.    * *New*
  993.      Create a new Fax document, and edit it using your configuration
  994.      editor.  The file pointed to by the configuration entry `Template'
  995.      will be used as a fax pro-forma.  The system will pick a default
  996.      document name for you, which you may keep or override.
  997.  
  998.    * *Edit*
  999.      Edit a Fax document, using your configuration editor. Note that you
  1000.      may set both a text and a graphic editor in your  `config' file.
  1001.  
  1002.    * *Make*
  1003.      The system will attempt to build an AFAX file from your source
  1004.      document. This is not necessary when sending faxes, but does allow
  1005.      you to check whether the document will appear as you wish.
  1006.  
  1007.    * *Preview*
  1008.      Invokes the AFAX viewer program, so you can preview the completed
  1009.      document.
  1010.  
  1011.    * *Send*
  1012.      Your facsimile document will be queued for sending to the
  1013.      appropriate recipients.  If the fax-spooler is not running, you
  1014.      will be asked if you wish to start it.
  1015.  
  1016.    * *QCheck*
  1017.      This gadget will bring up the queue check window, to monitor the
  1018.      progress of outgoing Faxes. From here it is possible to requeue
  1019.      Faxes that have exceeded their error allowance, and to remove the
  1020.      spool files for faxes that have been successfully sent, or that
  1021.      are still queued for transmission.
  1022.  
  1023.  
  1024. FaxAutoAnswer
  1025. ==============
  1026.  
  1027. This icon will activate the background automatic-answer facility. If it
  1028. is already operating, you will get the choice of removing the existing
  1029. application (stopping it), or replacing it with the new version. You
  1030. may wish to replace it if you have modified the configuration file
  1031. settings.
  1032.  
  1033. Note that you should only activate the auto-answer system in this
  1034. fashion if you are  not  using the GETTY mode of operation, and only
  1035. want to receive facimile transmissions, not data.
  1036.  
  1037.  
  1038. FaxSpool
  1039. =========
  1040.  
  1041. This icon will activate the background fax-spooler program. If it is
  1042. already operating, you will get the choice of removing the existing
  1043. application (stopping it), or replacing it with the new version.  Note
  1044. that in normal operation the main AmigaFax program will start the
  1045. spooler for you when you queue a fax for transmission, or you will run
  1046. it up automatically in your startup sequence.  You may wish to replace
  1047. it if you have modified the configuration file settings.
  1048.  
  1049.  
  1050. Operating from the Shell
  1051. *************************
  1052.  
  1053. The main executable modules included in the release are:
  1054.  
  1055.    * `afax'       Intuitionized interface for AFAX create/edit/send etc
  1056.  
  1057.    * `newfax'
  1058.      Notifies new fax received, allows print/view/delete, etc
  1059.      [Intuitionized interface]
  1060.  
  1061.    * `afaxspl'
  1062.      Fax spooler daemon, many options/features
  1063.  
  1064.    * `mkafax'
  1065.      Convert documents to AmigaFax AFAX IFF file format
  1066.  
  1067.    * `afaxprt'
  1068.      Print and AmigaFax AFAX IFF file using preferences printer
  1069.  
  1070.    * `afaxsend'
  1071.      Send an AmigaFax AFAX IFF file to a remote Fax machine
  1072.  
  1073.    * `faa'
  1074.      Receive Fax documents in auto-answer mode
  1075.  
  1076.    * `afaxilbm'
  1077.      Convert pages from an AmigaFax AFAX IFF file to ILBM format
  1078.  
  1079.    * `viewafax'
  1080.      AmigaFax document viewer
  1081.  
  1082.    * `fxfx'
  1083.      Manipulates fax files
  1084.  
  1085.    * `dvifax'
  1086.      Converts TeX .dvi file to fax format (Registered version only)
  1087.  
  1088.    * `showlib'
  1089.      Display licence status
  1090.  
  1091.    * `printsymb'
  1092.      AmigaFax printer-driver print symbiont (assists afax.driver)
  1093.  
  1094.    * `FPrint'
  1095.      Redirect printer output to afax.driver
  1096.  
  1097.    * `FaxInfo'
  1098.      Print information about fax file
  1099.  
  1100.  
  1101. AFAX
  1102. =====
  1103.  
  1104. `AFAX:c/afax'
  1105. `Afax' takes only one command line option at present:
  1106.      afax [-f faxfile]
  1107. If the `faxfile' option is given, `Afax' will come up with the given
  1108. file name set as both its source and FAX file. This is used when `Afax'
  1109. is started from the fax printer-driver. A common source and fax file is
  1110. treated as a special case by the spooler, which will not delete the fax
  1111. file when transmission is complete.
  1112.  
  1113. This brings up a window which you can use to create new Fax documents,
  1114. edit the documents, create the actual AFAX files, and send your faxes.
  1115. It also allows you to monitor the status of faxes queued for
  1116. transmission and maintain the queues, and to re-queue faxes that have
  1117. exceeded teir allowed retry count.
  1118.  
  1119.  
  1120. NEWFAX
  1121. =======
  1122.  
  1123. `AFAX:C/newfax faxname'
  1124. This program is automatically invoked by faa when a fax is received. It
  1125. puts up a window informing you of the Fax, with details about it (name,
  1126. sender ID, number of pages), and allows you to view, print or delete
  1127. the document.
  1128.  
  1129.  
  1130. AFAXSPL
  1131. ========
  1132.  
  1133.      [run >nil: <nil:] afax:c/afaxspl  [-s] [-i n] [-d num]
  1134.  
  1135. With the `-s' option, the spooler will run once only, checking for any
  1136. faxes waiting to be spooled out. In this mode, it could be launched
  1137. using cron/dcron/amicron at whatever times you wish to send faxes.
  1138.  
  1139. Otherwise it will run in background and check for faxes to spool at
  1140. intervals of every `n' minutes, where `n' is the interval in minutes
  1141. from the configuration file default, optionally overridden by the `-i'
  1142. command-line switch. You could do this perhaps every 1/2 hour, (n =
  1143. 30), or even at 1 minute intervals while testing.
  1144.  
  1145. The spooler checks for files of the form `FAXSPOOL:*.SPL'. These are
  1146. human-readable. As calls progress, results are added to the end of the
  1147. file. If successfully sent, the file is renamed `FAXSPOOL:*.OK' . If
  1148. unsuccessful for more than the specified number of tries, it is renamed
  1149. `FAXSPOOL:*.ERR'.
  1150.  
  1151. See Spool-File Format, for specifics on spool-file contents.
  1152.  
  1153. The queues are maintained from the `QCheck' module of the `afax'
  1154. command. See AFAX.
  1155.  
  1156. `-d' is used to specify the debug level (0-9).
  1157.  
  1158.  
  1159. MKAFAX
  1160. =======
  1161.  
  1162.      mkafax [-s][-f][-dn][-Rresfile] <docfilename> <AFAX_filename>
  1163.  
  1164. `mkafax' currently recognizes the IFF file types AFAX and ILBM, plain
  1165. text files, and AFAX command text files, as input.
  1166.  
  1167. A plain text file will be converted to an AFAX file using default
  1168. settings.
  1169.  
  1170. An IFF ILBM will be converted to a single-page FAX document. Only the
  1171. first plane is converted, to convert multi-plane (eg DigiView Pics) use
  1172. another tool, such as PfiltView (AmigaTeX).
  1173.  
  1174. See AmigaFax Command File Format, for a full description of the
  1175. command-file formatting instructions.
  1176.  
  1177. The switches `-s' and `-f' are used to force `Standard' and `Fine'
  1178. resolution repectively.
  1179.  
  1180. `-d0' to `-d9' sets the debug level.
  1181.  
  1182. The `-R' option specifies the name of the file to pass operational
  1183. results in. This is meant for internal use only, and is not a feature
  1184. guaranteed to be maintained. However some users have found it useful in
  1185. their environment, if you need to know the file format please ask me
  1186. for it.
  1187.  
  1188.  
  1189. AFAXSEND
  1190. =========
  1191.  
  1192.      afaxsend [-options]  <dialstring | alias> <AFAX_filename>
  1193.  
  1194. The present options are:
  1195.      -t         Tone Dial (default is Pulse)
  1196.      -P         DoPadding on  (Uppercase P)
  1197.      -p         DoPadding off (Lowercase p)
  1198.      -d n       Set debug level, 0-9
  1199.      -D device  Use named device    (default serial.device)
  1200.      -U unit    Use specified unit  (default 0)
  1201.      -Rfile     Write result in file
  1202.  
  1203. Command line options are normally not used, and settings are taken from
  1204. environment values of `Faxlib:config'. If given, the command line
  1205. switches take precedence.
  1206.  
  1207. The `-R' option specifies the name of the file to pass operational
  1208. results in. This is meant for internal use only, and is not a feature
  1209. guaranteed to be maintained. However some users have found it useful in
  1210. their environment, if you need to know the file format please ask me
  1211. for it.
  1212.  
  1213. `afaxsend' attempts to dial out, connect to the remote fax machine, and
  1214. tranfer the specified document.
  1215.  
  1216. `afaxsend Jeff MyFaxFile'
  1217.  
  1218. If the first character of dialstring is not a digit, and not a name
  1219. alias, the whole string will we be sent to the modem non-prefixed as a
  1220. dial string. If an alias is used, it may be a group alias, resulting in
  1221. the fax being sent to everyone in that group.
  1222.  
  1223.  
  1224. AFAXPRT
  1225. ========
  1226.  
  1227.      afaxprt [-pnum] [-n] [-dn]<AFAX_filename>
  1228.  
  1229. eg `afaxprt -p2 MyFaxFile'
  1230.  
  1231. If the `-p' option is not used, all pages are printed.
  1232.  
  1233. Using the `-n' option causes `afaxprt' not to send the data to the
  1234. printer. Useful with the debug option `-d'.
  1235.  
  1236. `afaxprt' sends the AmigaFax document to the preferences printer. It is
  1237. a good idea to set your printer for high density.  Using a dot-matrix,
  1238. Halftone Dithering, Integer Scaling, Black and White, Density 7 appears
  1239. to work ok.
  1240.  
  1241.  
  1242. FAA
  1243. ====
  1244.  
  1245. `faa [BaseName]'
  1246.  
  1247. Fax auto-answer. Sets up the FaxModem to auto-answer and recognise Fax
  1248. or data tranmissions. Incoming Faxes will be saved in AFAX format. the
  1249. default BaseName is `FAXREC:FAX', so that incoming faxes will be named
  1250.      FAXREC:FAX0000
  1251.      FAXREC:FAX0001
  1252.      FAXREC:FAX0002
  1253.  
  1254. etc.
  1255.  
  1256. Note also that although `faa' recognises the difference between Fax and
  1257. Data, it currently does nothing special with data. This may be
  1258. integrated with the UUCP system in the future, along with *VoiceMail*
  1259. capability.
  1260.  
  1261. To terminate the `faa' program, send it a CTL_C break. If you ran it
  1262. directly from your shell, just type control-C and wait. If you used
  1263. `RUN' or `RUNBACK', send a break to its process number. (eg break 7 all)
  1264.  
  1265. Command Line switches are:
  1266.      -a    - Immediate Answer
  1267.      -dn    - Set debug on, level n     (default 1)
  1268.      -D name    - Use name for the device     (default serial.device)
  1269.      -U num    - Use device unit num         (default 0)
  1270.      -G    - Run from a Getty
  1271.      -z    - Diagnostic, do not detach, so debug messages can be read
  1272.      -p    - Bump task priority by 1
  1273.      -Q    - Qtest mode
  1274.  
  1275. The Immediate Answer switch assumes phone is ringing, configures the
  1276. modem & answers immediately. It probably makes sense to attach this to
  1277. an alias if you use it this way. eg. `alias fa "faa -a"'
  1278.  
  1279. The Getty option specifies that faa was run from a Getty. It will not
  1280. modify the serial port parameters. It assumes that the Getty has
  1281. answered the phone, detected a Fax call, and set up the line
  1282. accordingly. Faa will connect, collect a Fax document, and return
  1283. control to the Getty.
  1284.  
  1285. If the `Qtest' option is specified, however, the baud rate will be set
  1286. to `RRate' even if `Getty' mode is specified. This was added for
  1287. compatability testing with `TrapDoor', a Getty-type front-end program.
  1288.  
  1289. As `faa' will normally detach, and so debug diagnostics are not
  1290. visible, the `-z' option was added to keep its STDIO attached to the
  1291. launching console.
  1292.  
  1293.  
  1294. AFAXILBM
  1295. =========
  1296.  
  1297.      afaxilbm [-pnum] <AFAX_filename> <ILBM_filename>
  1298.      
  1299.      eg
  1300.      
  1301.      afaxilbm -p2 RAM:AFAXR001 FX.ILBM
  1302.  
  1303. This will extract the specified page from the AFAX file to the named
  1304. ILBM file. It may then be viewed using standard ILBM viewing programs,
  1305. such as LoadImage from Fish disks 281 and 355, of programs like
  1306. DeluxePaint.
  1307.  
  1308. If no page number is given, all pages will be extracted to separate
  1309. files, and given names of the format base.1 base.2, etc
  1310.  
  1311. The default ILBM file base name is afax_ilbm
  1312.  
  1313.  
  1314. VIEWAFAX
  1315. =========
  1316.  
  1317.      viewafax [opts] <FaxFile>
  1318. The fax viewer is normally started automatically from the `NewFax'
  1319. window. When invoked from the CLI, it takes the options:
  1320.      -d debug_level
  1321.      -p Page_Number
  1322.      -s Scale
  1323.  
  1324. The current version of the viewer keeps one entire fax page in memory.
  1325. If the page will not fit in the requested scale, it tries to reduce the
  1326. resolution until it finds one that will fit. Once a page is displayed,
  1327. you can move about the page using the arrow keys. There is a scale
  1328. gadget at the top left of the window, in the form of 1:n, where n is
  1329. the current scale (say 3). You can click on the gadget, delete the
  1330. current scale, and enter your own, in the range 1 to 8, where 1 is 1:1
  1331. (full size), 2 is 1:2 (half size) etc. To the right of that gadget is
  1332. another of the form Page: n where n is the current page displayed.
  1333. Again you may enter the required page number in this gadget.
  1334.  
  1335. To the top right of the window is a group of gadgets of the form
  1336. `|<<-->>|'. These are actually four gadgets, which allow moving through
  1337. the pages of the fax. From left to right they are First Page, Previous
  1338. Page, Next Page, and Last Page.
  1339.  
  1340. You may use the windows sizing gadget to resize the window. However
  1341. with the current viewer, sizing the window larger than the fax page
  1342. will result in the window shrinking to the page size at the next
  1343. movement.
  1344.  
  1345. Several keys are active in the viewer window.
  1346.  
  1347.    * *Down Arrow* (Cursor Key or Numeric Pad) Move window down fax page.
  1348.  
  1349.    * *Up Arrow* (Cursor Key or Numeric Pad) Move window up fax page.
  1350.  
  1351.    * *Right Arrow* (Cursor Key or Numeric Pad) Move window right on fax
  1352.      page.
  1353.  
  1354.    * *Left Arrow* (Cursor Key or Numeric Pad) Move window left on fax
  1355.      page.
  1356.  
  1357.    * *Numeric pad keys 1,3,7,9* Diagonal window movement
  1358.  
  1359.    * *i* Flip fax page vertically. Useful when faxes are sent
  1360.      upside-down.
  1361.  
  1362.    * *q* Quit from viewer
  1363.  
  1364.    * *b* Move back on page in fax file
  1365.  
  1366.    * *n* Move to next page in fax file
  1367.  
  1368.    * *f* Move to first page in fax file
  1369.  
  1370.    * *e* Move to end page in fax file
  1371.  
  1372.    * *s* Make fax smaller - reduce scale one step
  1373.  
  1374.    * *l* Make fax larger - increase scale one step
  1375.  
  1376.  
  1377. FXFX
  1378. =====
  1379.  
  1380. This utility allows you to split and merge AFAX format fax files. A
  1381. typical use is where you have a complete fax document, perhaps
  1382. generated by TeX->dvifax, or received as an AFAX fax-file and you want
  1383. to sent it with an attached cover page, or you want to extract one or
  1384. more pages from the document.
  1385.  
  1386.      The command-line format is:
  1387.      
  1388.      fxfx [-f][-s] infile [-range] [infile[-range]] [...] outfile
  1389.      
  1390.      Some examples:
  1391.      
  1392.      fxfx file1 file2
  1393.      
  1394.       copies fax files file1 to file2
  1395.      
  1396.      fxfx file1 file2 file3 file4
  1397.      
  1398.       merges all pages from file1-3 to create file4
  1399.      
  1400.      fxfx file1 file2 -1,3,5-7,9- file3 -4 file4
  1401.      
  1402.       merges all pages from file1, pages 1,3,5-7 and 9 on from file2, and
  1403.       page 4 from file3, to create file4
  1404.      
  1405.      
  1406.      The range is currently sorted, so to reverse page order is currently
  1407.      not simple, eg
  1408.      
  1409.      fxfx file1 -3 file1 -2 file1 -1 file2
  1410.      
  1411.       to create file2 from pages 1-3 of file1 in reverse order.
  1412.  
  1413. The flags `-s' and `-f' are used to override the resolution flags when
  1414. translating. This may be useful when a fax machine has sent you a fax
  1415. with the incorrect resolution flags, as a fax machine in Brazil does to
  1416. me. It sends in `Standard', but sets the `Fine' flag. I can correct
  1417. this with
  1418.  
  1419. `fxfx -s faxfile newfaxfile'
  1420.  
  1421.  
  1422. DVIFAX
  1423. =======
  1424.  
  1425. This module works with the AmigaTeX package from Radical Eye Software,
  1426. to enable you to convert a TeX  `.dvi'  file into an AmigaFax fax file.
  1427.  
  1428. The command line syntax is
  1429.      dvifax file.dvi -o file.afx
  1430.  
  1431. You will be prompted for various size and scaling numbers. You are
  1432. probably best to accept the default values (hit return) unless you have
  1433. a very good idea what you are doing.
  1434.  
  1435. The  Squeeze Fax  option will remove all white-space from the top and
  1436. bottom of each page. This can result in significant savings in
  1437. transmission time, and in fax paper at the other end.
  1438.  
  1439. When creating faxes with `dvifax', you may want to add a cover page.
  1440. This can be done easily with the  `fxfx'  utility.
  1441.  
  1442.  
  1443. SHOWLIB
  1444. ========
  1445.  
  1446. This programs attempts to open the `afax.library' and display its
  1447. contents. You can use this to confirm that a valid license library is
  1448. available, check for user name, expiry date, etc. Output is of the form:
  1449.  
  1450.      Current AmigaFax Library:
  1451.      
  1452.      Version = 1
  1453.      Type    = 1
  1454.      Serial  = 0
  1455.      No Expiry
  1456.      Level   = 10
  1457.      User    = David Varley
  1458.  
  1459. For registered users the fields `Serial' and `User' should display your
  1460. registration serial number and your name. The `Version' field is an
  1461. internal library revision, the `Type' field is reserved and may be
  1462. later used to distinguish between reviewer, distributor, user, etc. The
  1463. `Level' is presently unused, but could be used for a service level, and
  1464. there may also be an licence expiry date shown. At present all
  1465. registered user licences should show `No Expiry'.
  1466.  
  1467.  
  1468. PRINTSYMB
  1469. ==========
  1470.  
  1471. The `printsymb' module is used to translate data from the `afax.driver'
  1472. printer driver into fax format, and save as a file. Under AmigaDOS2.0
  1473. it will be run automatically by the driver, but under AmigaDOS1.3 it
  1474. must be run up manually. It may be run in background, using a command
  1475. such as `RunBack', from somewhere in your startup sequence.
  1476.  
  1477. You can also run it manually from a CLI for diagnostic purposes. When
  1478. run manually it takes the command line arguments
  1479.      -h   Hang Around. Do not terminate when afax.driver is expunged
  1480.      -r   Replace.     Replace a currently running printsymb
  1481.      -q   Quit.        Kill any currently running printsymb and terminate
  1482.  
  1483. If you run `printsymb' from a normal shell window, and print using the
  1484. `afax.driver.debug' version of the driver, you will get lot of
  1485. diagnostic information about how your application program is accessing
  1486. the printer device. This can be useful for me in getting the driver to
  1487. work with as many applications as possible.
  1488.  
  1489.  
  1490. FPRINT
  1491. =======
  1492.  
  1493. `FPrint' is a small program that changes the in-memory system
  1494. `Preferences' to use the `afax.driver', puts up a requester informing
  1495. you that print has been redirected, and waits for you to signal it to
  1496. cease redirection. This can be useful for quickly redirecting output to
  1497. a fax without changing your main preferences settings, especially if
  1498. you tie `FPrint' to a `HotKey' using a program such as `FKeys'.
  1499.  
  1500. `FPrint' may not always work as expected, however, as some applications
  1501. will adjust the printer from saved settings. For these you will have to
  1502. use the normal `Printer' command to set your default printer to
  1503. `afax.driver'.
  1504.  
  1505.  
  1506. FAXINFO
  1507. ========
  1508.  
  1509. `FaxInfo' is a small utility that displays the header information from
  1510. a fax file, including the sender ID, date and number of pages. It is
  1511. passed a list of fax file names on the command line. If given the `-n'
  1512. command line option, the information is also attached to the file's
  1513. FileNote area. This utility can be useful for scanning a directory of
  1514. received files, to determine ones from a particular number or area
  1515. code, for example.
  1516.  
  1517.  
  1518. AmigaFax Command File Format
  1519. =============================
  1520.  
  1521. An AFAX command file uses lines starting with a dot (.) as special
  1522. commands, similar to TROFF style text processors. The file MUST start
  1523. with .FCOM on the first line.
  1524.  
  1525.       .FCOM
  1526.          on the first line to be recognised as a command file.
  1527.          .FCOM may optionally be followed by a dialstring or target alias.
  1528.          (Currently unused, future compatability)
  1529.      
  1530.      Other commands currently supported are :
  1531.      
  1532.       .PG    Clear out the old page and start a new one
  1533.       .LM n    Set the left margin to n characters, in the current font
  1534.       .LI n    Set the left  indentation to n pixels (default 50)
  1535.       .RI n    Set the right indentation to n pixels (default 50)
  1536.       .LJ    Left-justify text and Graphics from now on
  1537.       .RJ    Right Justify text and Graphics
  1538.       .CT    Center Text and Graphics
  1539.       .TS n    Set Tabs every n characters (default 8)
  1540.       .PL n    Set page length to n (pixel) rows (default 2292 == A4)
  1541.       .FILL    Turn on fill mode
  1542.       .NOFILL Turn off fill mode
  1543.      
  1544.       .VERBATIM
  1545.          All text read in will be printed verbatim, until .ENDVERB
  1546.      
  1547.       .VERBINC filename
  1548.          Include a file in verbatim mode. Still requires a .ENDVERB
  1549.      
  1550.       .ENDVERB
  1551.          End verbatim mode
  1552.      
  1553.       .FONT name size [styles]
  1554.          Set the font as specified. Typical use might be
  1555.          .FONT topaz 11
  1556.          .FONT diamond 20
  1557.          .FONT cmr10 30
  1558.          and so on. See the .STYLE command for style options.
  1559.      
  1560.       .ENDF    pop the current font/style, and return to the previous one.
  1561.      
  1562.       .STYLE styles
  1563.          Set the style according to the style string,
  1564.              N - Normal
  1565.              B - Bold
  1566.              U - Underlined
  1567.              I - Italics
  1568.              E - Extended
  1569.          eg .STYLE BU    (set to bold, underlined)
  1570.      
  1571.       .     (dot followed by white-space) Rest of line is a comment
  1572.      
  1573.       .INC file
  1574.          Include the named file. File may be text, ILBM, or another command
  1575.          file. Type is auto-recognised. If a full path is not given to the
  1576.          include file, the current directory will be searched, then the
  1577.          FAXLIB: directory. Thus addresses, signatures, etc may be kept
  1578.          in FAXLIB:
  1579.      
  1580.          From version 1.34, you may also .INC an AFAX format file. At
  1581.          present only one page is included, by default the first page.
  1582.          Page number can be specified by an optional parameter, eg
  1583.          .INC FAXREC:Fax0001 2
  1584.          At present only 1 page from an AFAX file can be included for each .INC
  1585.          command, and no data after that page will appear on the page it is
  1586.          included on. Text/graphics can be included before the included fax
  1587.          page, so you could use this, for example, to automatically add some
  1588.          header text to a received fax before relaying it on.
  1589.          Note that at present, normal page-length checking is NOT done while
  1590.          processing the included fax page, so you may get a longer than
  1591.          expected page.
  1592.      
  1593.       .DATE [FormatString]
  1594.          Insert a line with the current date and time, using current font
  1595.          and line settings.
  1596.      
  1597.          From mkafax version 1.43, the format string may be one of the following:
  1598.      
  1599.          "INTERNAL"  ........ internal date format like in AFax until V1.35
  1600.          "D"         ........ internal date format for Germany (new)
  1601.          "F"         ........ internal date format for France (new)
  1602.          "E"         ........ internal date format for "English" (new)
  1603.          "SHORT"     ........ short format from locale.library
  1604.          "LONG"      ........ long format from locale.library
  1605.          "%d.%m.%y"  ........ a valid format string for AmigaOS>=2.1 -
  1606.                       FormatDate()-routine in locale.library
  1607.          The locale.library stuff works under OS>=2.1 only !!
  1608.      
  1609.          If no FormatString is given, the value given in the config
  1610.          variable DateFormat is used. If Config entry is not found,
  1611.          then INTERNAL is choosen as the default.
  1612.          If locale.library is not found, although it is needed, automatical
  1613.          fallback to the INTERNAL format is performed.
  1614.  
  1615. Any line not beginning with a . will be processed as normal text,
  1616. according to the current settings.
  1617.  
  1618.  
  1619. Fill Mode
  1620. ----------
  1621.  
  1622. In this mode, lines will be filled from input to full width (inside LR
  1623. indent) in the current font. Line filling terminates on a dot command,
  1624. blank line, or end of page. Left Margin is disabled while filling.
  1625.  
  1626. See the included  `test.com'  file for examples of useage.
  1627.  
  1628.  
  1629. Stackable fonts and Style support
  1630. ----------------------------------
  1631.  
  1632. Version 1.34 and later of `mkafax' support stackable fonts, and the use
  1633. of styles, such as *Bold* , *Italic* and `Underline'.
  1634.  
  1635. Useage of the command  `.FONT'  has been extended, and the commands 
  1636. `.STYLE'  and  `.ENDF'  have been added.
  1637.  
  1638. The font system has been modified so that fonts are now nestable. This
  1639. means you can set a font/style, and then return to the original
  1640. font/style, without needing to know what that was. This can be very
  1641. useful for include files, which can return to the original font before
  1642. they exit, for example.
  1643.  
  1644. The  `.FONT'  command now takes an optional third parameter, which
  1645. defines the requested style to use. This takes the form of a string,
  1646. consisting of the letters  `N, B, U, I'  and  `E'  in any order, upper
  1647. or lower case.
  1648.  
  1649.      N - Normal
  1650.      B - Bold
  1651.      U - Underlined
  1652.      I - Italics
  1653.      E - Extended
  1654.  
  1655. Note that the letters are parsed in order, and that  `N'  will clear the
  1656. other flags and set the font back to normal. For example,
  1657.  
  1658.      .FONT topaz 30 BU
  1659. will set the font to topaz 30, Bold and Underlined.
  1660.  
  1661.      .FONT CGTimes 50 I
  1662. set CGTimes at 50-point, Italic.
  1663.  
  1664. You can retain the existing font, but change its style, by using the
  1665. new .STYLE command.
  1666.  
  1667.      .STYLE U
  1668.      
  1669.      This is Underlined.
  1670.      
  1671.      .STYLE IU
  1672.      
  1673.      This is Underlined and Italic.
  1674.  
  1675. All `.FONT' and `.STYLE' commands can now be nested. This means that
  1676. the font/style you set will remain in effect until the new command
  1677. `.ENDF' is encountered. After this the previous font/style set will be
  1678. in force. The Default font, which can be set from your `FAXLIB:Config'
  1679. file or by environmental variable, is always the underlying font. No
  1680. matter how many `.ENDF' commands you enter, this will not be popped
  1681. from the font stack.
  1682.  
  1683. Note that if you have defined a `Header' font, this will be
  1684. automatically pushed for headers, and popped afterwards.
  1685.  
  1686.      Example .FCOM file:
  1687.      
  1688.      .FCOM
  1689.      This is in default font
  1690.      .FONT CGTimes 30 U
  1691.      This is in Underlined 30 point CGTimes
  1692.      .FONT topaz 20 B
  1693.      This is in Bold 20 point topaz
  1694.      .STYLE NIU
  1695.      And this is Italic Underlined 20 point topaz
  1696.      .ENDF
  1697.      Bold 20 point topaz
  1698.      .ENDF
  1699.      Underlined 30 point CGTimes
  1700.      .ENDF
  1701.      Default font
  1702.      .ENDF
  1703.      Default font
  1704.  
  1705.  
  1706. Other Files
  1707. ************
  1708.  
  1709.  
  1710. FAXLIB:Aliases
  1711. ===============
  1712.  
  1713. This file allows you to alias numbers to names, create fax mailing
  1714. groups, etc. Aliases may be defined in terms of other aliases.
  1715.  
  1716. For example we could have:
  1717.  
  1718.      joe: 1234596
  1719.      
  1720.      fred: 9876123
  1721.      
  1722.      bill: 0981234
  1723.      
  1724.      andy: "0,123-4567,,,"
  1725.      
  1726.      customers: joe, fred, bill
  1727.  
  1728. Lines beginning with # are treated as comments, a comma means the alias
  1729. list continues.
  1730.  
  1731. If you want to include spaces or commas in an alias (commas are a way
  1732. of inserting delays into a dial-string), you should surround the
  1733. aliased number with double quotes. Adding coma-delays at the end of a
  1734. dial string can be useful when dialing numbers that take a long time to
  1735. respond, avoiding possible timeouts.
  1736.  
  1737. The alias system is modelled closely on the one used in Matt Dillon's
  1738. UUCP package. See UUCP documentation for more details. Thanks, Matt.
  1739.  
  1740.  
  1741. FONTS
  1742. ======
  1743.  
  1744. AmigaFax can use all the standard Amiga fonts. Under AmigaDOS2.0 the
  1745. ability to perform font-scaling means that you can generate quite
  1746. impressive documents very easily.
  1747.  
  1748. The AmigaFax distribution also includes a selection of larger sized
  1749. fonts from the Computer Modern series, which again allows very high
  1750. quality faxes to be produced. These were generated from standard TeX
  1751. fonts using the TEXF program. Note that these fonts do not contain the
  1752. umlaut characters commonly used in Europe.
  1753.  
  1754. These include the fonts  cmr10, cmbx10, cmssbx10 and cmtt10  in sizes
  1755. from 29 to 103.
  1756.  
  1757. I would suggest that anyone using AmigaDOS 2.0 use the standard Amiga
  1758. fonts. Even Topaz scaled to 30 point size or greater comes out quite
  1759. effectively. Play around until you find a setup you like.
  1760.  
  1761.  
  1762. Integration with other software
  1763. ********************************
  1764.  
  1765.  
  1766. UUCP
  1767. =====
  1768.  
  1769. AmigaFax was designed from the beginning to integrate with UUCP, in
  1770. particular with Matt Dillon's AmigaUUCP1.15D. Using the modified Getty
  1771. program provided, a Fax call will be recognised, and the Fax
  1772. auto-answer program will be called to handle it. Normal logins and UUCP
  1773. connections should function as usual.
  1774.  
  1775. Other facilities, such as network fax-server capability, can be
  1776. provided to enhance the basic AmigaFax system.
  1777.  
  1778.  
  1779. TeX
  1780. ====
  1781.  
  1782. We have written a  `dvifax'  program, which will take a standard TeX
  1783. `.dvi'  file, and transform it to an AmigaFax file, with superb quality
  1784. output. This is now provided with the distribution.
  1785. Martin Steppler and Martin Horneffer have donated a set of `PasTeX'
  1786. compatability programs, to enable AmigaFax to run with the `PasTeX'
  1787. freely distributable TeX package. This package is included in the
  1788. distribution. *We have not tested these programs here.*
  1789.  
  1790.  
  1791. PostScript
  1792. ===========
  1793.  
  1794. PostScript support is not yet in place, but it is on the list. Priority
  1795. given depends on demand.
  1796.  
  1797.  
  1798. Printer Driver
  1799. ===============
  1800.  
  1801. The AmigaFax printer driver `afax.driver' allows any program that sends
  1802. its output via the standard Amiga printer-driver is able to create fax
  1803. files. This includes many desktop publishing packages, word-processors,
  1804. drawing and paint programs, etc.
  1805.  
  1806. *Be aware:* that the present version  of the afax.driver, as released
  1807. with AmigaFax version 1.40-1.43, only converts *print graphics dumps*
  1808. to fax files. Normal text sent to the printer is ignored. This may
  1809. change for future releases.
  1810.  
  1811.  
  1812. BBS Systems
  1813. ============
  1814.  
  1815. The FifoBBS BBS system for VLT is no longer distributed with AmigaFax. 
  1816. There several BBS systems that should work well alongside AmigaFax, the
  1817. one we are currently using at C-Born is *TransAmiga*. This is a freely
  1818. distributable shareware package which also supports FidoNet. It is
  1819. available from several sources, including Amiga ftp sites. See the file
  1820. BBSREADME in the distribution disk BBS directory for more details.
  1821.  
  1822.  
  1823. Registration and Maintenance
  1824. *****************************
  1825.  
  1826. AmigaFax has always been distributed in two versions. The demonstration
  1827. version was freely distributable, but had certain limitations, in
  1828. particular the ability to transmit and receive only single-page faxes.
  1829. The registered version was sent out directly to registered users, and
  1830. was made available in restricted access areas of the BBS, UUFS
  1831. fileserver and BMS. The majority of the package was the same for both
  1832. versions.
  1833.  
  1834. With the increasing ease of access to networked file storeage systems,
  1835. such as AmiNet, the ability of users to collect the latest registered
  1836. version of the software over a network would greatly ease the
  1837. distribution bottleneck. Registered software could also be distributed
  1838. by means such as the Fish CD-ROMs.
  1839.  
  1840. In order to implement this, AmigaFax Version 1.40 and later incorporate
  1841. a licence management facility, implemented as a loadable library,
  1842. `afax.library'. This means that on registration only a small library
  1843. file needs to be sent to a user with the AmigaFax package, and
  1844. registered users can always load and use all the features of the latest
  1845. distribution when it appears on the networks, BBS, CD-ROM, etc.
  1846.  
  1847. The licence library has facilities for various levels of access, and
  1848. for limited-time licences, so that users may try with all features
  1849. enabled for a limited period. If the licence library is not found, the
  1850. package will still operate fully in demonstration mode, which for many
  1851. casual users will meet all their requirements.
  1852.  
  1853.  
  1854. Getting Updates
  1855. ================
  1856.  
  1857. The latest version of AmigaFax is usually available on AmiNet soon
  1858. after release. It is also available from our BBS system, as well as via
  1859. e-mail, Matt Dillon's BMS (Batch Mail System) for AmigaUUCP, and from
  1860. our `ftpmail' email fileserver. We can also send it out on disk by mail
  1861. if necessary.
  1862.  
  1863. We now have a a direct Internet connection, however access may be
  1864. limited due to external corporate firewall policies. See if you can
  1865. `ftp' to `ftp.cborn.pth.alcoa.com'.
  1866.  
  1867. We have set up a mailing-list for AmigaFax related information. You can
  1868. joing the list by sending email to
  1869. amigafax-request@cborn.pth.alcoa.com, with the body containing the word
  1870. `subscribe'.
  1871.  
  1872. Our BBS system is *TransAmiga*, and it currently runs on the same line
  1873. as our AmigaFax, `+61-52-504140'.
  1874.  
  1875.      Our mailing address is:
  1876.      
  1877.      C-Born Software System
  1878.      59 West Fyans St.
  1879.      Geelong, 3220
  1880.      Victoria, AUSTRALIA.
  1881.      
  1882.      Phone +61-52-290144
  1883.      Fax   +61-52 290248
  1884.  
  1885. At present, the BMS server site is
  1886.  
  1887. `cborn.pth.alcoa.com'
  1888.  
  1889. ftpmail fileserver can be reached as
  1890.      ftpmail@cborn.pth.alcoa.com
  1891. You can reach me by email as
  1892.      dave@cborn.pth.alcoa.com
  1893.  
  1894. You can request help on useage of the `ftpmail' fileserver by sending it
  1895. email containing the following body text:
  1896.      help
  1897.  
  1898.  
  1899. Registration
  1900. =============
  1901.  
  1902. The registration fee has been held at $A65, or $US50, for several years
  1903. now. (The original offer was valid until 6 April 1992, but we never got
  1904. around to changing it) We accept MasterCard, VISA and BankCard in
  1905. Australian dollars. EuroCheques are not accepted (we've tried, the
  1906. local banks won't accept them!).
  1907.  
  1908.      Here is an example registration form:
  1909.      
  1910.           o /
  1911.      ------X------cut here--------------------------------------------------
  1912.      
  1913.                         AMIGAFAX REGISTRATION
  1914.      
  1915.      To:
  1916.          C-Born Software Systems
  1917.          59 West Fyans St.
  1918.          Geelong, 3220
  1919.          Victoria, AUSTRALIA
  1920.      
  1921.      
  1922.      Name:                               Phone:
  1923.              _________________________            _________________________
  1924.      
  1925.      
  1926.      Address:
  1927.              _______________________________________
  1928.      
  1929.      
  1930.              _______________________________________
  1931.      
  1932.      Country:                                Postal Code:
  1933.              _________________________                     ________________
  1934.      
  1935.      
  1936.      Email:
  1937.              _________________________
  1938.      
  1939.      
  1940.      Payment Method:
  1941.      
  1942.      
  1943.       MasterCard  ( )     Visa  ( )     BankCard  ( )     Bank Cheque  ( )
  1944.      
  1945.      
  1946.      Card No.                                         Exp:
  1947.               _______________________________________       __________
  1948.      
  1949.      
  1950.      CardHolder Name:                                 Amount:  $65.00 Australian
  1951.                        ______________________________
  1952.      
  1953.      
  1954.           o /
  1955.      ------X------cut here---------------------------------------------------
  1956.  
  1957.  
  1958. Technical Details and File Formats
  1959. ***********************************
  1960.  
  1961.  
  1962. Spool-File Format
  1963. ==================
  1964.  
  1965. The format of the spool-file used to control timed transmission of
  1966. faxes should be regarded as for internal use, and subject to change. We
  1967. this proviso, we are making the format available as we have had several
  1968. requests from users who would like to write enhanced spooling code. At
  1969. present there are no plans to alter the syntax of the current entries,
  1970. however others may be added, and those writing software should allow
  1971. for this.
  1972.  
  1973.  
  1974.      The Spool File may contain the following KeyWords:
  1975.      
  1976.      Required
  1977.      --------
  1978.      To:      Destination
  1979.      Source:  Source file - could be text, iff-ilbm, command text, afax
  1980.      Fax:     Afax format file. If <8 bytes, will be created from source
  1981.      
  1982.      Optional
  1983.      --------
  1984.      Sendat:  Don't send until after this time
  1985.      From:    Sender of Fax
  1986.      Retries: Allowed number of failed tries before move to error queue
  1987.      Dispose: If set, then Source may be deleted once sent OK
  1988.      Result:  Result code for transmit
  1989.      Fine:    If present, build in FINE mode, else STANDARD
  1990.      Device:  Transmit fax on this device
  1991.      Unit:    Transmit fax on this unit
  1992.      SendOK:  Valid transmit time string (as in L.sys)
  1993.      
  1994.      Other key-words may be present, but will be ignored.
  1995.      
  1996.      The Sendat: time format is currently an Amiga longword time value, in
  1997.      ASCII and prefixed with the letter "L".
  1998.      The present code will take anything without leading L as time 0, so
  1999.      send any time.
  2000.      Other formats may be supported later, including ranged times.
  2001.      
  2002.      12AUG94 - Ranged time support (SendOK:) per L.sys:
  2003.      The valid time range may have no spaces, line format is:
  2004.      
  2005.          Any          the system can be called at any time
  2006.      
  2007.          Never        the system can never be called
  2008.      
  2009.          hh:mm-hh:mm  any day in the hour range indicated (24hr time)
  2010.      
  2011.          MoTuWeThFrSaSuhh:mm-hh:mm
  2012.                       On the days indicated in the hour range indicated.
  2013.      
  2014.          <timespec>,<timespec>
  2015.          MoTuWeThFr02:00-03:00,SaSu00:00-23:59
  2016.                  On the days indicated in the hour range indicated,
  2017.                  time specs separated by commas.
  2018.  
  2019. See AFAXSPL.
  2020.  
  2021.  
  2022. AFAX IFF File Format
  2023. =====================
  2024.  
  2025. Note that the afax file format may be changed at some later date to a
  2026. general standard cross-platform fax-file format. Also individual header
  2027. items may change, but changes are likely to me minor additions, so as
  2028. to avoid breaking existing code.
  2029.  
  2030. This is not a formal description, but should be sufficient for those
  2031. wishing to read or write compatible files.
  2032.  
  2033.  
  2034.      general IFF form is:
  2035.      
  2036.       * AFAX        - Amiga Fax FORM
  2037.       *   FXHD    - Document header
  2038.       *   FXPG     - One fax page
  2039.       *     FPHD    - Page header
  2040.       *     FX1D    - Page Data
  2041.      
  2042.      
  2043.      
  2044.      FXHD    Overall Fax document header
  2045.      ====
  2046.          UWORD w;    /* Width in pixels (Max for doc) */
  2047.          UWORD h;    /* Height in lines (Max for doc) */
  2048.      
  2049.          UBYTE vr;    /* Per T30 */
  2050.          UBYTE wd;
  2051.          UBYTE ln;
  2052.          UBYTE df;
  2053.      
  2054.          char lid[20];    /* Local and Remote ID strings */
  2055.          char rid[20];
  2056.      
  2057.          LONG Stime;    /* Send and receive times */
  2058.          LONG Rtime;
  2059.      
  2060.          UBYTE Flags;    /* b0 set for RAW data */
  2061.          UBYTE pages;    /* Number of pages */
  2062.      
  2063.          UWORD Pad[3];    /* Probably forgot something... */
  2064.      
  2065.      
  2066.      
  2067.      FPHD    Fax Page Header
  2068.      ====
  2069.      
  2070.          UWORD w;    /* Width in pixels */
  2071.          UWORD h;    /* Height in lines */
  2072.      
  2073.          UBYTE vr;    /* Per T30 */
  2074.          UBYTE df;
  2075.      
  2076.          UBYTE Type;    /*  = 0 for 1-d coded data */
  2077.          UBYTE Flags;    /*  status, 0=ok,1=failed,2=timed out reading */
  2078.  
  2079.  
  2080. FaxModem Specifics
  2081. *******************
  2082.  
  2083.  
  2084. ZyXEL U-1496
  2085. =============
  2086.  
  2087. The ZyXEL U-1496 provides data rates to v32bis and higher, with v42bis
  2088. error correction and compression. It is capable of facsimile data rates
  2089. greater than 9600bps, currently up to 14400bps. ZeroOne makes ROM
  2090. upgrades available through their BBS, with frequent upgrades. They are
  2091. very helpful and responsive to customer requests.
  2092.  
  2093. The latest ROM version we have used is  V6.13 .
  2094.  
  2095. With this ROM, it is possible to lock the DCE/DTE data rate for fax
  2096. with the sequence `ATS38=8S18=n' , where  n  is the DTE speed as per
  2097. the S20 register list, eg 2 for 38.4Kbps, 3 for 19.2Kbps.
  2098.  
  2099. There is a Voice-mode ROM for the ZyXEL currently in Beta-test. When
  2100. this is released, we will try to integrate it with AmigaFax. this will
  2101. allow you to send and receive voice messages, as well as fax and data
  2102. calls, all from your Amiga.
  2103.  
  2104. A few more tips on configuration, with getty. In my standard startup
  2105. line I have been setting the page-length to A4, as my printer is A4,
  2106. which is the standard here. However, it appears that my fax (and most
  2107. others) when appending their header/footer lines, force the page past
  2108. A4. This has not been a problem in the past, but now the U1496 must be
  2109. obeying the page-length setting, and forces out an extra very short
  2110. page for each A4 page. This causes handshake problems, etc.
  2111.  
  2112. So for now, the best solution seems to be setting up for unlimited
  2113. page-length. The AmigaFax software has no problem with this, but your
  2114. printer may, if single-sheet type.
  2115.  
  2116. Another option allows fax data-rates greater than 9600. Not many fax
  2117. machines support this yet, but we may as well use it, just in case.
  2118.  
  2119. The latest versions of this modem support Class-2.0 operation as well
  2120. as Class-2, and AmigaFax appears to work correctly in either mode.
  2121.  
  2122.      The +FDCC options are as follows:
  2123.      
  2124.      +FDCC=1,5,0,2
  2125.            ^ ^ ^ ^
  2126.            | | | +- Page Length: 0=A4(297mm) 1=B4(364mm) 2=unlimited
  2127.            | | +--- Page Width : 0=1728 Pixels in 215mm
  2128.            | +----- Bit Rate   : 0=2400 1=4800 2=7200 3=9600 4=12000 5=14400
  2129.            +--------Vert. Res. : 0=Normal(98 lpi) 1=Fine(196 lpi)
  2130.  
  2131. Other options cover compression format, error correction mode, binary
  2132. file transfer, and scan time. These are not yet supported, probably not
  2133. until the standards are finalized.
  2134.  
  2135. The line I use to start up `Getty' is:
  2136.  
  2137.      RunBack Getty -Mh -B19200 -x8 -F6 AT&C1&D3+FDCC=1,5,0,2
  2138.  
  2139. As I have the FaxModem running from a  AS2232  multiport serial card,
  2140. with a maximum baud rate of 19200, I must limit the DCE/DTE rate to
  2141. that.
  2142.  
  2143. When running with ROM version 6.13 and AmigaFax in Class-2.0 mode, I
  2144. run `Getty' up with the command line
  2145.  
  2146.      RunBack getty -Mh -B19200 -x9 -F14 AT&C1&D3+FCC=1,5,0,2
  2147.  
  2148.  
  2149. Maestro 9600XR
  2150. ===============
  2151.  
  2152. This is a low-cost Australian made 2400bps data, 9600bps send/receive
  2153. fax modem, based on the Exar chipset. It does not allow DCE/DTE rate
  2154. locking, and as of the latest version ROMs we have, still has
  2155. occasional problems in correctly synchronising to incoming fax data,
  2156. resulting in `garbage data' faxes, and missing lines from the top of
  2157. pages. These problems may have been fixed in later ROM versions, but we
  2158. have not been notified of any upgrades. The modem software does not
  2159. appear to observe specified line-scan delays, which may result in
  2160. missing lines when transmitting to older/slower fax machines.
  2161.  
  2162. A typical Getty startup-line for this modem is:
  2163.      run >nil: <nil: Getty -Mh -B2400 -F AT&C1&D2+FDCC=1,3
  2164.  
  2165.